//
//  NSObject+SLModel.h
//  SLModel
//
//  Created by S_Line on 2018/6/21.
//  Copyright © 2018年 S_Line. All rights reserved.
//

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN
/**
 Provide some data-model method:
 
 * Convert json to any object, or convert any object to json.
 * Set object properties with a key-value dictionary (like KVC).
 * Implementations of 'NSCoding', 'NSCopying', '-hash' and '-isEqual:'.
 
 See 'SLModel' protocol for custom methods.
 
 Sample Code:
 
    *********************** json convertor ***********************
 @code
     @interface SLAuthor: NSObject
     @property (nonatomic, strong) NSString *name;
     @property (nonatomic, assign) NSDate *birthday;
     @end
     @implementation SLAuthor
     @end
 
     @interface SLBook: NSObject
     @property (nonatomic, copy) NSString *name;
     @property (nonatomic, assign) NSUInteger pages;
     @property (nonatomic, strong) YYAuthor *author;
     @end
     @implementation SLBook
     @end
 
     int main() {
        // create model from json
        SLBook *book = [SLBook sl_modelWithJson:@"{\"name\": \"Harry Potter\", \"pages\": 256, \"author\": {\"name\": \"J.K.Rowling\", \"birthday\": \"1965-07-31\"}}"];
        // convert model to json
        NSString *json = [book sl_modelToJSONString];
        // {"author": {"name": "J.K.Rowling", "birthday": "1965-07-31T00:00:00+0000"}, "name": "Harry Potter", "pages": 256}
     }
 @endcode
 
    *********************** Coding/Coping/hash/equal ***********************
 @code
     @interface SLShadow: NSObject<NSCoding, NSCopying>
     @property (nonatomic, copy) NSString *name;
     @property (nonatomic, assign) CGSize size;
     @end
 
     @implementation SLShadow
     - (void)encodeWithCoder:(NSCoder *)aCoder {
        [self sl_modelEncodeWithCoder: aCoder];
     }
     - (id)initWithCoder:(NSCoder *)aDecoder {
        self = [super init];
        return [self sl_modelInitWithCoder: aDecoder];
     }
     - (id)copyWithZone:(NSZone *)zone {
        return [self sl_modelCopy];
     }
     - (NSUInteger)hash {
        return [self sl_modelHash];
     }
     - (BOOL)isEqual:(id)object {
        return [self sl_modelIsEqual: object];
     }
     @end
 @endcode
 */
@interface NSObject (SLModel)

/**
 Creates and returns a new instance of the receiver from a json.
 This method is thread-safe.
 
 @param json A json object in `NSDictionary`, `NSString`, `NSData`.
 
 @return A new instance created from the json, or nil if an error occurs.
 */
+ (nullable instancetype)sl_modelWithJSON:(id)json;

/**
 Creates and returns a new instance of the receiver from a key-value dictionary.
 This method is thread-safe.
 
 @param dictionary A key-value dictionary mapped to the instance's properties.
 Any invalid key-value pair in dictionary will be ignored.
 
 @return A new instance created from the dictionary, or nil if an error occurs.
 
 @discusstion The key in `dictionary` will mapped to the receiver's property name,
 and the value will set to the property. If the value's type does not match the property,
 this methos will try to convert the value based on these rules:
 
    `NSString` or `NSNumber` -> c number, such as BOOL, int, long, float, NSUInteger...
    `NSString` -> NSDate, parsed with format "yyyy-MM-dd'T'HH:mm:ssZ", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-dd".
    `NSString` -> NSURL.
    `NSValue` -> struct or union, such as CGRect, CGSize, ...
    `NSString` -> SEL, Class.
 */
+ (nullable instancetype)sl_modelWithDictionary:(NSDictionary *)dictionary;

/**
 Set the receiver's properties with a json object.
 
 @discussion Any invalid data in json will be ignored.
 
 @param json A json object of `NSDictionary`, `NSString` or `NSData`, mapped to the receiver's properties.
 
 @return Whether succeed.
 */
- (BOOL)sl_modelSetWithJSON:(id)json;

/**
 Set the receiver's properties with a key-value dictionary.
 
 @param dictionary A key-value dictionary mapped to the receiver's properties.
 Any invalid key-value pair in dictionary will be ignored.
 
 @discussion The key in `dictionary` will mapped to the receiver's property name,
 and the value will set to the property. If the value's type doesn't match the property,
 this methos will try to convert the value based on these rules:
 
    `NSString` or `NSNumber` -> c number, such as BOOL, int, long, float, NSUInteger...
    `NSString` -> NSDate, parsed with format "yyyy-MM-dd'T'HH:mm:ssZ", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-dd".
    `NSString` -> NSURL.
    `NSValue` -> struct or union, such as CGRect, CGSize, ...
    `NSString` -> SEL, Class.
 */
- (BOOL)sl_modelSetWithDictionary:(NSDictionary *)dictionary;

/**
 Generate a json object from the receiver's properties.
 
 @return A json object in `NSDictionary` or `NSArray`, or nil if an error occurs.
 See [NSJSONSerialization isValidJSONObject] for more information.
 
 @discusstion Any of the invalid property is ignored.
 If the receiver is `NSArray`, `NSDictionary` or `NSSet`, it just convert the inner object to json object.
 */
- (nullable id)sl_modelToJSONObject;

/**
 Generate a json string's data from the receiver's properties.
 
 @return A json string's data, or nil if an error occurs.
 
 @discussion Any of the invalid property is ignored.
 If the receiver is `NSArray`, `NSDictionary` or `NSSet`, it will alse convert the inner object to json string.
 */
- (nullable NSData *)sl_modelToJSONData;

/**
 Generate a json string from the receiver's properties.
 
 @return A json string, or nil if an error occurs.
 
 @discussion Any of the invalid property is ignored.
 If the receiver is `NSArray`, `NSDictionary` or `NSSet`, it will alse convert the inner object to json string.
 */
- (nullable NSString *)sl_modelToJSONString;

/**
 Copy a instance with the receiver's properties.
 
 @return A copied instance, or nil if an error occurs.
 */
- (nullable id)sl_modelCopy;

/**
 Encode the receiver's properties to a coder.
 
 @param aCoder An archiver object.
 */
- (void)sl_modelEncodeWithCoder:(NSCoder *)aCoder;

/**
 Decode the receiver's properties from a decoder.
 
 @param aDecoder An archiver object.
 
 @return self
 */
- (id)sl_modelInitWithCoder:(NSCoder *)aDecoder;

/**
 Get a hash code with the receiver's properties.
 
 @return Hash code.
 */
- (NSUInteger)sl_modelHash;

/**
 Compares the receiver with another object for equality, based on properties.
 
 @param model Another object.
 
 @return `YES` if the receiver is equal to the object, otherwise `NO`.
 */
- (BOOL)sl_modelIsEqual:(id)model;

/**
 Description method for debugging purposes based on properties.
 
 @return A string that describes the contents of the receiver.
 */
- (NSString *)sl_modelDescription;

@end

@interface NSArray (SLModel)

/**
 Creates and returns an array from a json-array.
 This method is thread-safe.
 
 @param cls The instance's class in array.
 @param json A json array of `NSArray`, `NSString`, or `NSData`.
        Example:[{"name": "Mary"}, {"name": "Joe"}]
 
 @return A array, or nil if an error occurs.
 */
+ (nullable NSArray *)sl_modelArrayWithClass:(Class)cls json:(id)json;

@end

@interface NSDictionary (SLModel)

/**
 Creates ane returns a dictionary from a json.
 This method is thread-safe.
 
 @param cls The value instance's class in dictionary.
 @param json a json dictionary of `NSDictionary`, `NSString`, or `NSData`.
    Example:{"user1": {"name": "Mary"}, "user2": {"name": "Joe"}}
 
 @return A dictionary, or nil if an error occurs.
 */
+ (nullable NSDictionary *)sl_modelDictionaryWithClass:(Class)cls json:(id)json;

@end

@protocol SLModel <NSObject>

@optional
/**
 Custom property mapper.
 
 @discussion If the key in JSON/Dictionary dose not match to the model's property name,
 implements this method and returns the additional mapper.
 
 Example:
     json:
         {
             "n": "Harry Pottery",
             "p":256,
             "ext": {
                "desc": "A book written by J.K.Rowling."
             },
             "ID": 100010
         }
 
     model:
     @code
         @interface SLBook: NSObject
             @property NSString *name;
             @property NSInteger page;
             @property NSString *desc;
             @property NSString *bookID;
         @end
         @implementation SLBook
             + (NSDictionary *)modelCustomPropertyMapper {
                 return @{
                     @"name": @"n",
                     @"page": @"p",
                     @"desc": @"ext.desc",
                     @"bookID": @[@"id", @"ID", @"book_id"]
                };
             }
         @end
     @endcode
 @return A custom mapper for properties.
 */
+ (nullable NSDictionary<NSString *, id> *)modelCustomPropertyMapper;

/**
 The generic class mapper for container properties.
 
 @discussion If the property is a container object, such as NSArray/NSSet/NSDictionary,
 implements this method and return a property->class mapper, tells which kind of
 object will be add to the array/set/dictionary.
 
 Example:
 @code
     @class SLShadow, SLBorder, SLAttachment;
 
     @interface SLAttributes
         @property NSString *name;
         @property NSArray *shadows;
         @property NSSet *borders;
         @property NSDictionary *attachments;
     @end
 
     @implementation SLAttributes
         + (NSDictionary *)modelContainerPropertyGenericClass {
             return @{
                 @"shadow": [SLShadow class],
                 @"borders": SLBorder.class,
                 @"attachments": @"SLAccachment"
            };
         }
     @end
 @endcode
 
 @return A class mapper.
 */
+ (nullable NSDictionary<NSString *, id> *)modelContainerPropertyGenericClass;

/**
 If you need to create instances of different classes during json->object transform,
 use the method to choose custom class based on dictionary data.
 
 @discussion If the model implements this method, it will be called to determine resulting class
 during '+modelWithJson:', '+modelWithDictionary:', conveting object of properties of parent objects
 (both singular and containers via'+modelContainerPropertyGenericClass').
 
 Example:
 @code
     @class SLCircle, SLRectangle, SLLine;
     @implememtation SLShape
         + (Class)modelCustomClassForDictionary:(NSDictionary *)dictionary {
             if (dictionary[@"radius"] != nil) {
                return [SLCircle class];
             } else if ([dictionary[@"width"] != nil) {
                return [SLRectangle class];
             } else if (dictionary[@"y2"] != nil) {
                return [SLLine class];
             } else {
                return [self class];
             }
         }
     @end
 @endcode
 
 @param dictionary The json/kv dictionary.
 
 @return Class to create from this dictionary, 'nil' to user current class.
 */
+ (nullable Class)modelCustomClassForDictionary:(NSDictionary *)dictionary;

/**
 All the properties in blacklist will be ignored in model transform process.
 Returns nil to ignore this feature.
 
 @return An array of property's name.
 */
+ (nullable NSArray<NSString *> *)modelPropertyBlacklist;

/**
 If a property is not in the whitelist, it will be ignored in model transform process.
 Returns nil to ignore this feature.
 
 @return An array of property's name.
 */
+ (nullable NSArray<NSString *> *)modelPropertyWhitelist;

/**
 This method's behavior is similar to '- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic',
 but be called before the model transform.
 
 @discussion If the model implements this methos, it will be call ed before
 `+modelWithJSON:`, `+modelWithDictionary:`, `-modelSetWithJSON:` and `-modelSetWithDictionary:`.
 If thie method returns nil, the transform process will ignore this model.
 
 @param dic The json/kv dictionary.
 
 @return Returns the modified dictionary, or nil to ignore this model.
 */
- (NSDictionary *)modelCustomWillTransformFromDictionary:(NSDictionary *)dic;

/**
 If the default json-to-model transform dose not fit to your model object, implement
 this method to do additional process. You can also use this method to validate the model's properties.
 
 @discussion If the model implements this method, it will be called at the end of
 `+modelWithJSON:`, `+modelWithDictionary:`, `-modelSetWithJSON:` and `-modelSetWithDictionary:`.
 If this method returns NO, the transform process will ignore thie model.
 
 @param dic The json/kv dictionary.
 
 @return Returns YES if the model is valid, or NO to ignore this model.
 */
- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic;

/**
 If the default model-to-json transform does not fir to your model class, implment
 this methos to do additional process. You can also use this method to validate the json dictionary.
 
 @discussion If the model implements this method, it will be called at the end of
 `-modelToJSONObject` and `-modelToJSONString`.
 If this method returns NO, the transform process will ignore this json dictionary.
 
 @param dic The json dictionary.
 
 @return Returns YES if the model is valid, or NO to ignore this model.
 */
- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic;

@end

NS_ASSUME_NONNULL_END
